<?php
/*
+------------------------------------------------------------------------------+
| Copyright (c) 2008, Draftrack Team                                           |
| All rights reserved.                                                         |
|                                                                              |
| Redistribution and use in source and binary forms, with or without           |
| modification, are permitted provided that the following conditions are met:  |
|     * Redistributions of source code must retain the above copyright         |
|       notice, this list of conditions and the following disclaimer.          |
|     * Redistributions in binary form must reproduce the above copyright      |
|       notice, this list of conditions and the following disclaimer in the    |
|       documentation and/or other materials provided with the distribution.   |
|     * Neither the name of the <organization> nor the                         |
|       names of its contributors may be used to endorse or promote products   |
|       derived from this software without specific prior written permission.  |
|                                                                              |
| THIS SOFTWARE IS PROVIDED BY draftrack team ''AS IS'' AND ANY                |
| EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED    |
| WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE       |
| DISCLAIMED. IN NO EVENT SHALL draftrack team BE LIABLE FOR ANY               |
| DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES   |
| (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
| LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND  |
| ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT   |
| (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS|
| SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                 |
+------------------------------------------------------------------------------+

 * @category   Zend_extension
 * @package    Zend_View
 * @subpackage Helper
*/

/** Zend_View_Helper_Placeholder_Container_Standalone */
require_once 'Zend/View/Helper/Placeholder/Container/Standalone.php';

class Myzen_View_Helper_MessageDisplay extends Zend_View_Helper_Placeholder_Container_Standalone
{
	/**
     * Registry key for placeholder
     * @var string
     */
    protected $_regKey = 'Zend_View_Helper_MessageDisplay';

	
  /**
     * $_session - Zend_Session storage object
     *
     * @var Zend_Session
     */
    static protected $_session = null;	

  /**
     * $_namespace - Instance namespace, default is 'default'
     *
     * @var string
     */
    protected $_namespace = 'app_messageDisplay';
  
  /**
     * Allowed message types
     * @var array
     */
    protected $_allowedMessageTypes = array('error', 'warning', 'confirmation');

    /**
     * Which message type should be displyaed in priority
     * @var array
     */
    protected $_messageDisplayOrder = array('error'=>3, 'warning'=>2, 'confirmation'=>1);
    
        /**
     * Constructor
     *
     * Set separator to PHP_EOL.
     * 
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
        $this->setSeparator(PHP_EOL);
		
		$messagesArray = array();
		
		//We check if there are no messages left from the previous page call that would not have been displayed
		if (!self::$_session instanceof Zend_Session_Namespace) {
            self::$_session = new Zend_Session_Namespace($this->_namespace);
			self::$_session->setExpirationHops(1); //If messages have not been reseted they are displayed at the next page
			foreach (self::$_session as $type => $message) {
                $messagesArray[$type] = $message;
            }
        }
		//We put them in the container
        $this->getContainer()->messages = $messagesArray;
    }
  

    public function messageDisplay($message = null, $type = 'confirmation')
    {
        if (null !== $message && is_string($message) && in_array($type, $this->_allowedMessageTypes) ) {
         	$this->setMessage($message,$type); 
        }

        return $this;
    }
    

    /**
     * Save the message in the placeholder
     * 
     * @param  string $message
     * @param string $type  check _allowedMessageTypes for allowed types
     * @return string
     */    
    public function setMessage($message = null,$type= 'confirmation') {
    	
    	if (null !== $message && is_string($message) && in_array($type, $this->_allowedMessageTypes) ) {
         	$this->getContainer()->messages[$type] = $message;
        }
		//We also store it on the session
		self::$_session->$type = $message;
    }
    
    
    /**
     * Create string representation of placeholder
     * only one message is returned, last error take precedence over last warning that takes precedence over cconfirmation
     * 
     * @param  void
     * @return string  html code that will be displayed, void if no message to return
     */
    public function toString()
    {
    	$messageToDisplay = '';
    	$maximumType = 0;
    	$maximumTypeName = '';
    	foreach ($this->getContainer()->messages as $type => $message) {
    		//message is of higher priority, it is the one that will be displayed
    		if($this->_messageDisplayOrder[$type] >= $maximumType) {
    			$messageToDisplay = $message;
    			$maximumTypeName = $type;
    			$maximumType = $this->_messageDisplayOrder[$type];
    		}
    	}
    	if(!empty($messageToDisplay)) {
			//Messages are being displayed, we unset the session (at least the displayed one)
			foreach($this->_allowedMessageTypes as $name) {
				if(isset(self::$_session->$name)) unset(self::$_session->$name);
			}
			
			
			//And we return an HTML string for the message
			return '<div class="message '.$maximumTypeName.'">'.$messageToDisplay.'</div>';
    	}
		return '';
    }
        
/*    
    public function messageDisplay($messages)
    {
        if(isset($messages['error'])) echo '<div class="message error">'.$messages['error'].'</div>';
    	elseif(isset($messages['warning'])) echo '<div class="message warning">'.$messages['warning'].'</div>';
    	elseif(isset($messages['confirmation'])) echo '<div class="message confirmation">'.$messages['confirmation'].'</div>';
    	return;
    }
*/

}

?>